<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>NPanday - NPanday .NET Build Tool Installation and Configuration</title>
    <style type="text/css" media="all">
      @import url("../../css/maven-base.css");
      @import url("../../css/maven-theme.css");
      @import url("../../css/site.css");
    </style>
    <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
          </head>
  <body class="composite">
    <div id="banner">
                  <a href="" id="bannerLeft">
    
                                            <img src="../.././images/NPanday.png" alt="" />
    
            </a>
                        <a href="http://www.codeplex.com/" id="bannerRight">
    
                                            <img src="../.././images/logo-home.png" alt="" />
    
            </a>
            <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
            
  
    
            <div class="xleft">
          
                <a href="http://npanday.codeplex.com/" class="externalLink">NPanday Home</a>
                &gt;
      
                <a href="../../">NPanday 1.2</a>
                  </div>
            <div class="xright">      
  

  
    
            
  
    
             Last Published: 22 Jun 2010
              &nbsp;| Version: 1.2
            </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
            
  
    
                   <h5>General Info</h5>
            <ul>
              
    <li class="none">
                    <a href="../../index.html">NPanday Overview</a>
          </li>
              
    <li class="none">
                    <a href="../../release-notes.html">NPanday Release Notes</a>
          </li>
              
    <li class="none">
                    <a href="../../faqs.html">NPanday FAQs</a>
          </li>
              
    <li class="none">
                    <a href="../../faqs.html">NPanday Features</a>
          </li>
              
    <li class="none">
                    <a href="../../npanday.pdf">Documentation PDF</a>
          </li>
          </ul>
              <h5>User's Guide</h5>
            <ul>
              
    <li class="none">
                    <a href="../.././guide/index.html">Introduction</a>
          </li>
              
    <li class="none">
                    <a href="../.././guide/installation/index.html">Installation</a>
          </li>
              
    <li class="none">
                    <a href="../.././guide/vs/index.html">Visual Studio Add-in</a>
          </li>
              
    <li class="none">
                    <a href="../.././guide/maven/index.html">Maven Command Line</a>
          </li>
              
    <li class="none">
                    <a href="../.././guide/devinfra/index.html">Maven Development Infrastructure</a>
          </li>
              
    <li class="none">
                    <a href="../../plugins/index.html">NPanday Plugins</a>
          </li>
          </ul>
              <h5>Contributing</h5>
            <ul>
              
    <li class="none">
                    <a href="../.././developers/index.html">Developer's Guide</a>
          </li>
              
    <li class="none">
                    <a href="../.././issue-tracking.html">Issue Tracking</a>
          </li>
              
    <li class="none">
                    <a href="../.././mail-lists.html">Mailing Lists</a>
          </li>
          </ul>
              <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="../../project-info.html">Project Information</a>
                </li>
          </ul>
              <h5>Resources</h5>
            <ul>
              
    <li class="none">
                    <a href="http://maven.apache.org/" class="externalLink">Apache Maven</a>
          </li>
              
    <li class="none">
                    <a href="http://npanday.codeplex.com/" class="externalLink">NPanday on CodePlex</a>
          </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="../../images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
            
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2>Pre-requisites</h2>
<p>Running NPanday's Maven plugins requires the following on your system:</p>
<ul><li>Maven 2.0.9 or above (see <a class="externalLink" href="http://maven.apache.org/download.html"> Maven's download page</a> for instructions).</li>
<li>Java Runtime Environment (JRE) 1.5 or greater. Also, the <tt>JAVA_HOME</tt> environment variable must be set to the directory where the JRE is installed, for example, <tt>C:\Program Files\Java\jre1.5.0_06</tt>. The <tt>java</tt> executable must also be available on your path.</li>
<li>Visual Studio 2005 (SP1) or the .NET 2.0 SDK for developing .NET 2.0 applications and libraries</li>
<li>Visual Studio 2008 (SP1) or the Windows 7 SDK for .NET 3.5 SP1 for developing .NET 3.5 (and earlier) applications and libraries</li>
</ul>
<p>If you later have problems relating to being unable to find the SDK, refer to the <a href="../reference/troubleshooting.html"> Troubleshooting</a> section. </p>
</div>
<div class="section"><h2>Preparation</h2>
<p>Before installing NPanday, you may need to do some further preparation.</p>
<div class="section"><h3>Removing a Previous Version</h3>
<p>While it is generally safe to install the new version without uninstalling the previous version, to ensure a clean system you may want to follow the <a href="./uninstall.html"> Uninstalling NPanday</a> instructions.</p>
</div>
<div class="section"><h3><a name="Set_the_PATH">Set the PATH</a></h3>
<p>All Maven commands must be run with the PATH set for the .NET SDKs. This can usually be achieved by starting the appropriate command prompt shortcuts supplied with the SDK or Visual Studio.</p>
<p>In addition, at present the NPanday Add-in runs Maven directly and so also requires that all the SDKs are already on the path - something which is not usually the case when Visual Studio is run.</p>
<p>The method you use to set the PATH environment can vary, depending on how you usually launch Visual Studio:</p>
<ul><li>If you are starting Visual Studio from the Windows Start menu, use the following to set the PATH environment variable in the System Properties: <tt>Start &gt; My Computer &gt; View System Information &gt; Advanced &gt; Environment variables</tt>. The variable must have all the additional elements that are added when you run the Visual Studio Command Prompt.</li>
<li>From within the Visual Studio Command Prompt, you can start Visual Studio using the <tt>devenv</tt> command.</li>
</ul>
<p>The easiest way to obtain the full PATH is to call <tt>set path</tt> from the Visual Studio Commmand Prompt of the corresponding Visual Studio version. Then use copy-paste to set this PATH permanently to your Environment Variables.</p>
<p>The correct PATH should include the following:</p>
<ul><li>The .NET framework runtime(s) - all that are needed (<tt>C:\WINDOWS\Microsoft.NET\Framework\v3.5</tt> and/or <tt>C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727</tt>)</li>
<li>The .NET SDK - only the latest (<tt>C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin</tt> or <tt>C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\bin</tt> or other location if installed aside from Visual Studio)</li>
<li>The Maven <tt>bin</tt> directory</li>
<li>The NUnit <tt>bin</tt> directory if writing NUnit tests</li>
</ul>
<p>If you are building .NET SDK 3.5 or Visual Studio 2008 projects, you must ensure that the elements for that environment are <i>before</i> any previous SDK versions.</p>
<p>The additional PATH fragment for Visual Studio 2008 will probably look like the following:</p>
<div class="source"><pre>C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE;C:\Program Files\Microsoft Visual Studio 9.0\VC\BIN;
C:\Program Files\Microsoft Visual Studio 9.0\Common7\Tools;C:\WINDOWS\Microsoft.NET\Framework\v3.5;
C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727;C:\Program Files\Microsoft Visual Studio 9.0\VC\VCPackages;
C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin;</pre>
</div>
<p>For Visual Studio 2005, it will likely be:</p>
<div class="source"><pre>C:\Program Files\Microsoft Visual Studio 8\Common7\IDE;C:\Program Files\Microsoft Visual Studio 8\VC\BIN;
C:\Program Files\Microsoft Visual Studio 8\Common7\Tools;C:\Program Files\Microsoft Visual Studio 8\Common7\Tools\bin;
C:\Program Files\Microsoft Visual Studio 8\VC\PlatformSDK\bin;C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\bin;
C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727;C:\Program Files\Microsoft Visual Studio 8\VC\VCPackages;</pre>
</div>
</div>
</div>
<div class="section"><h2>Visual Studio 2008</h2>
<p>For users that only have Visual Studio 2008 installed and no Visual Studio 2005, you would need to install .NET 2.0 SDK and add <tt>C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727</tt> to the PATH.</p>
<p>Found here: (x86: <a class="externalLink" href="http://www.microsoft.com/downloads/details.aspx?FamilyID=fe6f2099-b7b4-4f47-a244-c96d69c35dec&amp;displaylang=en"> .NET 2.0 SDK</a>)</p>
</div>
<div class="section"><h2>Obtaining NPanday</h2>
<p>NPanday releases are made available in two locations:</p>
<ul><li><a class="externalLink" href="http://npanday.codeplex.com/Release/ProjectReleases.aspx"> NPanday Download page</a> - for downloading a full repository to install locally</li>
<li><a class="externalLink" href="http://repo.npanday.org/archiva/repository/npanday-group"> NPanday Release and Dependencies Repository Group</a> - for downloading directly from Maven.<ul><li>Alternatively, you can use the pure <a class="externalLink" href="http://repo.npanday.org/archiva/repository/npanday-releases"> NPanday Release Repository</a>. You will also need to include the repository <a class="externalLink" href="http://repository.aduna-software.org/maven2">http://repository.aduna-software.org/maven2</a> for some dependencies.</li>
</ul>
</li>
</ul>
<p>In NPanday 1.1, the release is only made available as a Maven binary repository, or a source distribution. For information on how to build the project from source, see <a href="../../developers/building.html"> Building from Source</a> in the Developer's Guide. NPanday 1.2 and above include a Windows installer as an option.</p>
</div>
<div class="section"><h2>Installing Using the Downloaded Binary Repository</h2>
<p>In this guide, we will use the repository downloaded from the NPanday download page.</p>
<div class="section"><h3>Installing NPanday's Maven Plugins</h3>
<p>Whether you are using just the Visual Studio integration or the full set of capabilities, you must have the Maven environment installed.</p>
<p>For the purposes of this guide, we will copy the artifacts to our local environment only - however in most developer groups you will host the repository on a shared server that all developers can use to obtain the correct release.</p>
<p>After downloading the binary repository, unpack the contents (you may need a 3rd party application to expand the <tt>tar.gz</tt> format on Windows). Next, copy the contents of <tt>repository/releases</tt> from the archive to <tt>%HOMEDRIVE%%HOMEPATH%\.m2\repository</tt>. This is the default <i>local repository</i> of a Maven installation if it has not been modified in Maven's <tt>settings.xml</tt>.</p>
<p>For example, you may end up with a structure containing <tt>C:\Documents and Settings\User\.m2\repository\npanday\npanday-project\1.2\npanday-project-1.2.pom</tt>.</p>
<p>To confirm your installation, run the following command, replacing <tt>1.2</tt> with the version you are installing:</p>
<div class="source"><pre>mvn help:describe -DgroupId=npanday.plugin -DartifactId=maven-vsinstaller-plugin -Dversion=1.2</pre>
</div>
<p>If successful, you should receive the following output:</p>
<div class="source"><pre>Name: NPanday :: Visual Studio Addin Installer Maven Plugin
Description: Maven Plugin for .NET: Installs the Visual Studio Addin
Group Id: npanday.plugin
Artifact Id: maven-vsinstaller-plugin
Version: 1.2
Goal Prefix: vsinstaller

This plugin has 1 goal:

vsinstaller:install
  Description: Installs Visual Studio 2005 addin.</pre>
</div>
<p>If you don't intend to use the Visual Studio Add-in, you can now <a href="../maven/index.html"> get started using Maven</a>. </p>
</div>
<div class="section"><h3>Installing the Visual Studio Add-in</h3>
<p>To install the Add-in, first ensure that Visual Studio is not running.</p>
<p>Next, from a command prompt with the path set as indicated above, run the following command:</p>
<div class="source"><pre>mvn npanday.plugin:maven-vsinstaller-plugin:[version]:install</pre>
</div>
<p><b>Note:</b> On Windows Vista, Windows 7 and above, you will need to run the command as an administrator. This can be done by starting the command prompt using the <i>Run as administrator</i> option.</p>
<p>After running the <tt>maven-vsinstaller-plugin</tt> the add-in will be located here: <tt>C:\Documents and Settings\[user_home]\My Documents\Visual Studio 2005\Addins\NPanday.VisualStudio.AddIn</tt> (or equivalent for Visual Studio 2008).</p>
<p>More information on how to verify the Add-in installation are located at the end of this guide.</p>
</div>
</div>
<div class="section"><h2>Installing the Visual Studio Add-in using the NPanday Installer</h2>
<p>NPanday Installer allows user to use NPanday automatically without the hassle of downloading the repository and running commands to install it. It will generate the repository and the add-ins for both VS2005 and VS2008.</p>
<p>To launch the NPanday Setup, click the installer twice,</p>
<img src="../../images/vs/installer/screen1.jpg" /><p>After clicking the 'Next' button, End-User License Agreement wizard page will prompt. Check the box and click the 'Next' button.</p>
<img src="../../images/vs/installer/screen2.jpg" /><p>Next wizard page will be for the Custom Setup which will allow user to change the way the features will be installed and the location of the repository.</p>
<p>If you are going to configure Maven to use NPanday installed on a remote repository, you can disable the installation of its artifacts in your local repository.</p>
<p>An item for the Visual Studio Addin should appear for each version of Visual Studio that you have installed. You can then select which of these you wish for the Addin to be installed into.</p>
<img src="../../images/vs/installer/screen3.jpg" /><p>After changes were made, click on Next button and user will be redirected to the Installation wizard page. Click on the 'Install' button to start installation.</p>
<img src="../../images/vs/installer/screen4.jpg" /><p>If installation was successful, user will be prompted with this:</p>
<img src="../../images/vs/installer/screen5.jpg" /><p>After running the installer the add-in will be located here: <tt>C:\Documents and Settings\[user_home]\My Documents\Visual Studio 2005\Addins\NPanday.VisualStudio.AddIn</tt> (or equivalent for Visual Studio 2008).</p>
<p>You can verify that the Maven plugins are also installed correctly by following the same steps as shown in the previous section.</p>
</div>
<div class="section"><h2>Verifying the NPanday Add-in</h2>
<p>To verify that the NPanday .NET Build Tool has been configured inside Visual Studio, perform the following instructions:</p>
<ol type="1"><li>Launch Visual Studio (either from the command line or from the Windows Start&gt; menu).</li>
<li>From inside Visual Studio, select Tools&gt;NPanday Build System. This automatically starts NPanday and displays a confirmation in the Visual Studio Output window at the bottom of the Visual Studio screen.</li>
</ol>
<img src="../../images/vs/installer/verify_installation.jpg" alt="NPanday Build System" /><p>You can also set Visual Studio to automatically start NPanday Build System upon startup by checking NPanday.VisualStudio.Addin in Tools &gt; Add-in Manager.</p>
<p>After it starts, you will not see NPanday Build System listed in the Tools menu, until the next time you start Visual Studio.</p>
<div class="section"><h3>Getting Started with the Visual Studio Add-in</h3>
<p>You can now start Visual Studio and test the Add-in. The next section of this guide will focus on <a href="../vs/index.html"> using the Visual Studio Add-in</a>.</p>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2010
    
          NPanday
          
  

  
    
            
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
